Skip to content

[naga spv-out] Consolidate explanation of global wrapping. #6336

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Oct 3, 2024
Merged

[naga spv-out] Consolidate explanation of global wrapping. #6336

merged 1 commit into from
Oct 3, 2024

Conversation

jimblandy
Copy link
Member

Consolidate the explanation of why and how we wrap Naga global variables in structs to satisfy Vulkan's requirements, and include it in the documentation for back::spv::GlobalVariable.

Clarify GlobalVariable's members documentation.

@jimblandy jimblandy added area: documentation Documentation for crate items, public or private area: naga back-end Outputs of naga shader conversion naga Shader Translator lang: SPIR-V Vulkan's Shading Language labels Sep 28, 2024
@jimblandy jimblandy requested a review from a team September 28, 2024 00:13
@jimblandy jimblandy force-pushed the naga-spv-out-doc-GlobalVariable branch from e5a4a5f to 9364cbe Compare October 1, 2024 20:33
ErichDonGubler
ErichDonGubler approved these changes Oct 2, 2024
View reviewed changes
Copy link
Member

@ErichDonGubler ErichDonGubler left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, some non-blocking nits.

@jimblandy
[naga spv-out] Consolidate explanation of global wrapping.
150ad8d 
Consolidate the explanation of why and how we wrap Naga global
variables in structs to satisfy Vulkan's requirements, and include it
in the documentation for `back::spv::GlobalVariable`.

Clarify `GlobalVariable`'s members documentation.
@jimblandy jimblandy force-pushed the naga-spv-out-doc-GlobalVariable branch from 9364cbe to 150ad8d Compare October 3, 2024 17:02
@jimblandy jimblandy enabled auto-merge (rebase) October 3, 2024 17:02
@jimblandy jimblandy merged commit d3e09dd into gfx-rs:trunk Oct 3, 2024
27 checks passed
@jimblandy jimblandy deleted the naga-spv-out-doc-GlobalVariable branch October 4, 2024 03:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ErichDonGubler ErichDonGubler ErichDonGubler approved these changes

Assignees
No one assigned
Labels
area: documentation Documentation for crate items, public or private area: naga back-end Outputs of naga shader conversion lang: SPIR-V Vulkan's Shading Language naga Shader Translator
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@jimblandy @ErichDonGubler